M

Document.NewFlexPipe

Description:
Adds a new flexible pipe into the document, using a connector, point array and pipe type.

Remarks:
If the connector is a fitting or equipment connector of the correct domain, and if the connector's direction matches the direction of the flexible pipe to be created, the connectors will be automatically connected. A transition fitting will be added at the connector(s) if necessary. If the connector's type, domain, does not match the one of the input connector, no connection will be established.

Overloads (3):

NewFlexPipe

NewFlexPipe(Connector,Connector,FlexPipeType)

NewFlexPipe(Connector,IList[XYZ],FlexPipeType)

NewFlexPipe(IList[XYZ],FlexPipeType)

public FlexPipe NewFlexPipe(
	Connector connector,
	IList<XYZ> points,
	FlexPipeType pipeType
)

Public Function NewFlexPipe ( 
	connector As Connector,
	points As IList(Of XYZ),
	pipeType As FlexPipeType
) As FlexPipe

public:
FlexPipe^ NewFlexPipe(
	Connector^ connector, 
	IList<XYZ^>^ points, 
	FlexPipeType^ pipeType
)

member NewFlexPipe : 
        connector : Connector * 
        points : IList<XYZ> * 
        pipeType : FlexPipeType -> FlexPipe

Connector

connector

The connector to be connected to the flexible pipe, including the end points.
IList<XYZ>

points

The point array indicating the path of the flexible pipe.
FlexPipeType

pipeType

The type of the flexible pipe.

Return Value FlexPipe If creation was successful then a new flexible pipe is returned, otherwise an exception with failure information will be thrown.

ArgumentNullException

Thrown when the input argument connector or points is.
InvalidOperationException

Thrown when the flexible pipe cannot be created or regenerate fails.
ArgumentException

Thrown if the flexible pipe type does not exist in the given document.